home *** CD-ROM | disk | FTP | other *** search
- SpiritEd
- (Version 1.1)
-
- INSTRUCTION MANUAL
-
-
- About SpiritEd...
-
- SpiritEd is a simple GEM-based text editor in the form of a desk
- accessory. It is written to provide an ability to take notes and prepare
- lessons from within SpiritWare's Bible concordance program. However, you
- may find it useful in a wide variety of applications.
-
- Like all SpiritWare programs, SpiritEd is designed to be easy to use. If
- you have ever used a Macintosh, you already know how to use SpiritEd. Its
- use of the mouse, menus, and keyboard conforms as closely as possible to
- Macintosh user interface guidelines.
-
- It is important to bear in mind that SpiritEd is a text editor and not a
- word processor. As a text editor, it provides basic editing capabilities
- including cutting, copying, pasting, searching and replacing. It also has
- an undo function that allows you to cancel the last operation that was
- performed. It does not provide the formatting capabilities of a word
- processor. However, text entered into SpiritEd can be saved to a file and
- later imported into a full-featured word processor for formatting.
-
- About SpiritWare...
-
- SpiritWare is produced by servants of our Lord Jesus Christ at Fifteenth
- Avenue Bible Church in Seattle, Washington for the edification of His
- body. While SpiritWare is copyrighted, permission is granted for unlimited
- noncommercial copying and distribution of SpiritWare programs. This
- program can and should be freely distributed.
-
- Installing SpiritEd
-
- To install SpiritEd, simply copy SPIRITED.ACC from the distribution disk
- to the main directory of your boot disk or partition. SpiritEd will be
- available from the Desk Accessory menu of the desktop or any GEM-based
- program the next time you boot up. It is important to remember that if you
- use the standard GEM desktop, you can only have six desk accessories
- loaded at one time. If you already have six and you want to add SpiritEd,
- you will have to remove one of the others.
-
- Opening SpiritEd
-
- SpiritEd can only be accessed from the GEM desktop or GEM applications. To
- open SpiritEd, select SpiritEd from the desk accessory menu. The SpiritEd
- window will appear on the screen.
-
- Closing SpiritEd
-
- SpiritEd never really goes away, it is always hanging around in memory.
- You can make its window disappear by clicking on the go away box in the
- upper left corner of the window (or by pressing Control-Q).
-
- Moving the SpiritEd Window
-
- Like most GEM windows, the SpiritEd window can be moved to any position on
- the screen by dragging the Move Bar.
-
- Sizing the SpiritEd Window
-
- The SpiritEd window can be resized either by clicking on the Full Box in
- the upper right corner of the window, or by dragging the Size Box in the
- lower right corner of the window. The Full Box allows you to easily toggle
- between a full-screen window and a smaller sized window.
-
- Using the SpiritEd Menu Bar
-
- Since desk accessories do not have access to the main menu bar, the menu
- bar for SpiritEd appears in its window. This menu bar can be accessed any
- time the SpiritEd window is active. Please note that when SpiritEd is
- active, the main menu bar becomes disabled. To reactivate the main menu
- bar you must click on one of the main application's windows. When the main
- menu bar is active, the SpiritEd window and menu bar are inactive.
-
- Like the main menu bar, SpiritEd menus drop down when the mouse pointer is
- placed over them. Unlike the main menu bar, SpiritEd menus automatically
- disappear when the mouse pointer is moved outside of the menu. To select a
- menu item, simply click on that item. Most SpiritEd menu items have
- keyboard equivalents which are shown on the right side of the menu.
- Instead of using the mouse to select a command from a menu, the same
- command can be invoked from the keyboard. This is done by holding down the
- Control key and pressing the key indicated in the menu. For example, to
- open a file from the keyboard, press the Control key and the O key at the
- same time.
-
- Opening a File
-
- To open a file, select Open from the File menu. The Atari File Selector
- box will appear, allowing you to select the file you would like to edit.
- (If you don't know how to use the Atari File Selector, please refer to
- your ST owner's manual.)
-
- SpiritEd actually only opens the file long enough to copy its contents
- into memory. It then closes the file. Any changes that you make to the
- text only alter the copy that is in memory, not the original file that is
- on disk. These changes stay in memory, even when SpiritEd is not visible
- on the screen. To transfer your changes to the original file, you must
- save the text (see the next section).
-
- The fact that there are two copies of the text (a memory copy, used by
- SpiritEd, and a disk copy) present at the same time can sometimes be
- confusing. For example, let's say you are using SpiritEd and you open a
- text file called MYFILE.TXT. After making some changes in this file, you
- decide to print MYFILE.TXT from a desktop publishing program. So you close
- SpiritEd, start up the desktop publishing program, and open up MYFILE.TXT.
- But none of the changes you made are there! Actually they are, but they
- are in SpiritEd's section of memory and not on disk. To solve this
- problem, you should open SpiritEd back up, save MYFILE.TXT, and then
- reopen MYFILE.TXT from the desktop publishing program. Another problem
- that can arise is forgetting to save a file before turning off your
- computer. Your file will be lost, since everything in memory disappears
- when the computer is turned off. Also, when your computer crashes, usually
- everything in memory is lost; therefore, it is wise to save the text
- frequently.
-
- Saving the Text
-
- To permanently record the changes that have been made, the text must be
- saved. When you save, the text that is being edited in memory is copied on
- to your disk. To save, select Save from SpiritEd's File menu (or press
- Control-S). You will be presented with Atari's File Selector. Check the
- entries in the "Directory:" and "Selection:" fields; if they are correct,
- press the OK button. If they are not correct, change them and the press
- the OK button. (See your ST Owner's Manual for details on how to use the
- File Selector).
-
- When you use the Save command, the text is saved without carriage returns
- at the end of each wrapped line. The only carriage returns that are saved
- are the ones that you have actually inserted into the text. This is the
- format that SpiritEd expects to find when it opens a file. However, some
- word processors expect to find carriage returns at the end of each line.
- To save a file in this format, use the Print command and select the Print
- to File option. The file will be saved just as it would be printed, with
- the left margin padded with spaces as determined by the current Printer
- Left Margin setting and the width of the text limited by the current
- Printer Text Width setting. (These settings are controlled through the
- Options command in the SpiritWare menu.)
-
- Viewing the Text
-
- Like most GEM applications, you can use the Scroll Bar to view any part of
- the text. The small white box within the Scroll Bar, called the Scroll
- Box, indicates roughly where you are in the text with respect to the
- beginning and end of the text. The Scroll Box itself can be moved by
- dragging it up or down. To move to the top of the text, drag the Scroll
- Box to the top of the Scroll Bar. Likewise, to go to the bottom of the
- text, drag the Scroll Box down to the bottom of the Scroll Bar.
-
- The up and down arrows in the Scroll Bar move the text up or down one line
- at a time. To move the text up one full screen, click in the gray area
- above the Scroll Box; click in the gray area below the Scroll Box to move
- the text down one full screen. Scrolling the text one full screen at a
- time can also be done from the keyboard. To move down in the text, you can
- use either F1 or Control-Down Arrow (i.e., hold the Control key down and
- press the Down Arrow cursor key). To move up in the text from the
- keyboard, press either F2 or Control-Up Arrow.
-
- Moving the Cursor
-
- The cursor position is indicated by thin flashing line, called the
- insertion point. The insertion point can be moved up, down, left, or right
- by pressing the corresponding cursor key. In addition, you can move the
- insertion point to the end of a line by holding down the Shift key and
- pressing the Right Arrow cursor key. To move to the beginning of a line,
- hold down the Shift key and press the Left Arrow key.
-
- You can also position the insertion point by moving the mouse to the
- desired spot and pressing the mouse button. Please note that the position
- of the mouse in the text does not change when you scroll to another
- section of text.
-
- Entering Text
-
- When you press a key, the corresponding character is inserted into the
- text at the insertion point. You can use the Backspace key to erase the
- character to the left of the insertion point and the Delete key to erase
- the character to the right of the insertion point.
-
- As you enter text, SpiritEd will automatically start a new line when you
- reach the right-hand edge of the window. This process is called word
- wrapping. Do not use the Return key in the middle of a paragraph-- let
- SpiritEd wrap the line. You can use the Return key to force a carriage
- return at any point in the text; a small CR symbol appears in the text
- where the Return key has been pressed.
-
- Selecting Text
-
- When editing, it is often necessary to select a block of text. To select
- text, position the mouse at the start or the end of the block, press the
- left mouse button, and drag to the other end of the block. Selected text
- appears white on a black background. You can also select a block of text
- by "shift-clicking". This is done by positioning the insertion point at
- either the start or the end of the block you would like to select. Then,
- move the cursor to the other end of the block, hold down the Shift key,
- and click the left mouse button. One other way to select text is to
- double-click. Double-clicking on a word causes that word to become
- selected.
-
- Deleting Text
-
- There are several ways to delete text. First, as mentioned above, when
- there is no selected text, the Backspace key can be used to delete the
- character on the left of the insertion point, and the Delete key can be
- used to remove the character on the right. Second, one complete line of
- text can be deleted placing the cursor on that line and pressing
- Control-D. Third, a block of selected text can be deleted by selecting the
- block (see above) and then pressing either the Backspace key or the Delete
- key, or by using the Cut command from the Edit menu (see "Using the
- Clipboard", below).
-
- Replacing Text
-
- A quick way to replace a block with new text is to select the block (see
- above) and then start entering the new text. When a character is entered
- while a block of text is selected, that character replaces the block, and
- the insertion point is placed to the right of the character. Another way
- to replace a block of selected text is to use the Paste command from the
- Edit menu (see "Using the Clipboard", below) to replace the selected block
- with the contents of the clipboard. Finally, words can be automatically
- replaced throughout the text with the use of the Replace command (see
- below).
-
- Using the Clipboard
-
- The clipboard is used to store a block of text. Only one block can be
- stored at a time, so when a new block is put into the clipboard, the
- previous one is lost. The information that is placed in the clipboard is
- available to all programs that support the Atari clipboard standard. (This
- includes the SpiritWare concordance program. Information can be
- transferred from the concordance program to SpiritEd and from SpiritEd to
- the Concordance program via the clipboard.)
-
- The Edit commands, Cut and Copy (or Control-X and Control-C) are used to
- put a block of selected text onto the clipboard. (See above for
- instructions on how to select a block of text). The Cut command deletes
- the block of text after it copies it to the clipboard. The Copy command
- only copies the text to the clipboard.
-
- The information on the clipboard can be inserted into the text through the
- use of the Paste command (or Control-V). When the Paste command is
- selected, the contents of the clipboard are inserted into the text at the
- insertion point. If a block of text is selected when Paste is executed,
- the contents of the clipboard replaces the selected text.
-
- Using the Undo Command
-
- The Undo command is used to undo the last editing operation that was
- performed. For example, if you delete a block of text and then decided you
- did it wrong, you can restore the block by selecting Undo in the Edit menu
- or by pressing Control-Z or the Undo key. Or, if you just pasted the
- clipboard contents into the text and found that you put it in the wrong
- spot, you can remove it by using the Undo command.
-
- It is important to note that the Undo command reverses the effect of the
- last editing operation on the text, but does not reverse the effect of
- that operation on the clipboard. If the last operation was a Cut command,
- the Undo command will restore the text that was cut out, but the
- information that was on the clipboard before the Cut command was issued
- will not be restored.
-
- Using the Find Command
-
- To find a word in the text rapidly, you can use the Find command. When
- Find is selected from the Search menu (or Control-F is pressed), a dialog
- box appears on the screen, allowing you to enter the text string that you
- want to search for. You can also select whether you want the search to be
- case-sensitive, and whether you want the search to just look at whole
- words.
-
- A case-sensitive search will only find text that matches the upper and
- lower case characters of the string that you entered into the dialog box.
- For example, if the text string you entered was "peace", any occurrence of
- the string Peace would be ignored if the search was case-sensitive, but
- would be found if the search was not case-sensitive.
-
- To make sure that you do not find places where your search string matches
- just a part of a word, you can do a whole-word search. For example, if you
- are searching for the word rain, and your text has the word train in it,
- train will be found by the Find command unless you specify that you only
- want to find the whole word rain.
-
- The Find command starts searching from the current location of the
- insertion point or from the end of the currently selected block of text.
- If it reaches the end of the file before it finds the text it is looking
- for, it will place an alert box on the screen, telling you that it
- couldn't find the string and asking if you want to continue the search
- from the beginning of the file. If it does find the string you are looking
- for, it selects that text and positions it so that it can be seen on the
- screen.
-
- Once the string you are searching for has been found, you can initiate
- another search by selecting the Find Again command (or by pressing
- Control-A). The Find Again command assumes that you are looking for the
- same text string and that you want to do the same type of search that you
- did the last time.
-
- Using the Replace Command
-
- The Replace command can be used to find a word or character string and
- replace it with another word or character string. When Replace is selected
- from the Edit menu (or Control-R is pressed), a dialog box appears onto
- which allows you to enter the string you want to search for and the string
- you want to replace it with. Like the Find command, you can also select
- whether you want to replace only whole words and whether you want the
- search to be case-sensitive. (See the previous section for more
- information about these two options.)
-
- You can also select whether you want to replace every occurrence of the
- word. If you choose Yes, then every time that word or character string is
- found, it will be replaced. If you choose No, then each time the string is
- found, you will be asked if you want to replace it. If you select Yes, the
- string will be replaced and the next occurrence will be found. If you
- select No, the string will be left unchanged and the search will continue
- to the next occurrence of the string. If you select quit, the Replace
- command will be terminated.
-
- The Replace operation, like Find, starts at the insertion point and
- continues to the end of the file. Only the last occurrence of the string
- that was replaced is undoable.
-
- Printing
-
- You can print either the entire text, or a block of selected text by
- choosing the Print command from the File menu (or by pressing Control-P).
- (See above for instructions on how to select a block of text.) When
- printing, the text starts at the Left Margin setting and automatically
- wraps so it does not extend beyond the Text Width setting. (Left Margin
- and Text Width are set with the Option command, see below.) The Print to
- File option allows you to send the text to a file instead of the printer.
- For more information on how to use this option, refer to the section on
- saving text.
-
- Setting Options
-
- The Option command in the SpiritWare menu allows the user to control
- several different program parameters. The user can either make temporary
- changes to these options, or make them permanent so they automatically
- take effect each time the system is booted up. Permanent option settings
- are stored in a file called SPIRITED.OPT which is stored in the root
- directory of the boot drive.
-
- TAB SPACING - When you are entering text and you press the Tab key,
- SpiritEd inserts spaces into the text to move you to the next tab stop.
- The tab stops are spaced at even intervals across the screen. The Tab
- Spacing option is used to set the distance between tab stops. The default
- setting is two characters. [If you are going to import this text into a
- word processor or desktop publishing program, you may want to insert an
- actual tab, rather than spaces. This can be done by pressing Shift Tab. A
- clock face will appear on the screen to indicate the presence of the tab
- character and no spacing to the tab stop will occur.]
-
- AUTO INDENT - You can have SpiritEd automatically indent the start of each
- new paragraph by selecting the Auto Indent option. When this option is
- selected, and you press the return key, SpiritEd checks to see how far the
- previous paragraph was indented and indents the new paragraph the same
- amount. To use this option you need to manually indent the first
- paragraph.
-
- SAVE BACKUP - Each time you save you use the Save command, the version of
- the text that is in SpiritEd replaces the old contents of the file. You
- can have the old contents automatically saved into a backup file by
- selecting Save Backup. If you use the Save Backup feature, the old
- contents are placed into a file with a .BAK extension whenever you use the
- Save command. For example, if you are working with a file called
- MYFILE.TXT, the backup file would be called MYFILE.BAK.
-
- PRINTER LEFT MARGIN - This option allows you to control how big to the
- left margin will be when text is printed. The number you enter indicates
- how many spaces will be inserted at the left margin before a line of text
- is printed.
-
- PRINTER TEXT WIDTH - You can control the maximum number of characters
- SpiritEd will put on a line when printing by using this option. The number
- of characters you specify does not include the spaces placed at the left
- margin (see above).
-
- PRINTER LINE SPACE - This option allows you to control the number of line
- feeds that will be sent to the printer at the end of each line.
- Single-spacing of text is accomplished by entering 1 for this option and
- double-spacing by entering 2.
-
- MAX FILE SIZE - Use this option to control the amount of memory you want
- to set aside for SpiritEd to use while editing files. The amount of memory
- you should allocate depends on how much memory you have and how large the
- files are that you will be editing. Since the only time SpiritEd can
- allocate memory is when the computer is turned on or reset, the changes
- you make in this setting willl not be effective until you restart your
- computer.
-